home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / graphics / pstricks / read-me.pst < prev    next >
Text File  |  1993-04-07  |  14KB  |  338 lines
  1. %% BEGIN read-me.pst
  2. ***********************************************************************
  3. ****      "readme" file for PSTricks package, v0.93a, 93/03/12     ****
  4. ***********************************************************************
  5.  
  6. COPYRIGHT 1992, 1993 by Timothy Van Zandt, tvz@Princeton.EDU
  7.  
  8. COPYING:
  9.  
  10.   Copying of part or all of any file in the PSTricks package
  11.   is allowed under the following conditions only:
  12.  
  13.   (1) You may freely distribute unchanged copies of the files. Please
  14.       include the documentation when you do so.
  15.   (2) You may modify a renamed copy of any file, but only for personal
  16.       use or use within an organization.
  17.   (3) You may copy fragments from the files, for personal use or for use
  18.       in a macro package for distribution, as long as credit is given
  19.       where credit is due.
  20.  
  21.   You are NOT ALLOWED to take money for the distribution or use of
  22.   these files or modified versions or fragments thereof, except for
  23.   a nominal charge for copying etc.
  24.  
  25. DESCRIPTION:
  26.  
  27.   pstricks.tex is an extensive collection of PostScript macros that is
  28.   compatible with most TeX macro packages, including Plain TeX , LaTeX
  29.   AmSTeX and AmS-LaTeX. Included are macros for color, graphics, rotation,
  30.   trees and overlays. It has many special features, including:
  31.  
  32.     * There is a wide variety of graphics (picture drawing) macros, with
  33.       a flexible interface and with color support. All lines and outlines
  34.       can be solid, dotted or dashed. Lines and curves can have arrowheads,
  35.       t-bars, brackets or circles on the ends. Regions can be filled
  36.       with solid colors, lines or crosshatch.
  37.     * There is support for polar and cartesian coordinate systems.
  38.     * There are macros for plots and axes.
  39.     * Nested rotations can be made with respect to the physical page.
  40.     * There are flexible node macros, useful for trees, mathematical
  41.       diagrams, and linking information of any kind.
  42.     * There is a powerful loop macro that is useful for making pictures.
  43.     * There are macros for coloring or shading the cells of tables.
  44.  
  45.   PSTricks puts the icing (PostScript) on your cake (TeX)!
  46.  
  47. GETTING PSTRICKS
  48.  
  49.   The PSTricks package is available from
  50.  
  51.     Princeton.EDU:/pub/tvz
  52.  
  53.   and from several TeX ftp and mail-server archives.
  54.  
  55.   A bug list pstricks.bug is kept up-to-date on Princeton.EDU:/pub/tvz.
  56.  
  57.   Send requests to get on or off a PSTricks mailing list to the author.
  58.  
  59. FILES:
  60.  
  61.   Inputs:
  62.     pstricks.con : PSTricks configuration file.
  63.     pstricks.tex : Main macro file, for use with pstricks.pro.
  64.     pstricks.sty : Same as pstricks.tex.
  65.     pst-node.tex : Nodes and node connections, for use with pst-node.pro.
  66.     pst-node.sty : Same as pst-node.tex.
  67.     pst-plot.tex : Plots and axes.
  68.     pst-plot.sty : Same as pst-plot.tex.
  69.     pst-coil.tex : Coil and zigzag graphics objects, for use with pst-coil.pro.
  70.     pst-coil.sty : Same as pst-coil.tex.
  71.     gradient.tex : Gradient fill style.
  72.     gradient.sty : Same as gradient.tex.
  73.     charpath.tex : For filling and stroking character paths.
  74.     charpath.sty : Same as charpath.tex.
  75.     textpath.tex : For typesetting text along a path.
  76.     textpath.sty : Same as textpath.tex.
  77.     pst2eps.tex  : For creating eps files.
  78.     pst2eps.sty  : Same as pst2eps.tex.
  79.     multido.tex  : Contains the \multido macro.
  80.     multido.sty  : Same as multido.tex.
  81.     colortab.tex : For adding color to tables and other alignments.
  82.     colortab.sty : Same as colortab.tex.
  83.     fancybox.sty : Tips and tricks for LaTeX LR-boxes.
  84.  
  85.   PostScript:
  86.     pstricks.pro : PostScript prologue for pstricks.tex and Rokicki's dvips.
  87.     pst-node.pro : PostScript prologue for pst-node.tex.
  88.     pst-coil.pro : PostScript prologue for pst-coil.tex.
  89.     gradient.pro : PostScript prologue for gradient.tex.
  90.     textpath.pro : PostScript prologue for textpath.tex.
  91.  
  92.   Contributed:
  93.     palette.tex  : A palette of RGB colors, by Fred Knight.
  94.     palette.sty  : The same as palette.tex.
  95.     piechart.sh  : Unix shell script for making pie charts, by Denis Girou.
  96.     pie-data.sh  : Supplement to piechart.sh, by Denis Girou.
  97.  
  98.   Documentation:
  99.     read-me.pst  : This file (ASCII).
  100.     pst-usr1.ps  : User's Guide, part 1 (PostScript).
  101.     pst-usr2.ps  : User's Guide, part 2 (PostScript).
  102.     pst-usr3.ps  : User's Guide, part 3 (PostScript).
  103.     pst-usr4.ps  : User's Guide, part 4 (PostScript).
  104.     pst-quik.ps  : Quick Reference (PostScript).
  105.     changes.tex  : List of changes (LaTeX).
  106.     samples.tex  : A file of samples (LaTeX).
  107.     pst-test.tex : A test file (Plain TeX).
  108.     filetest.tex : Test various read and write operations (Plain TeX).
  109.     filetest.dat : A data file for testfile.tex (ASCII).
  110.     filetest.raw : PostScript input for testfile.tex (ASCII).
  111.     chartest.tex : Test file for charpath.tex (Plain TeX).
  112.     denis1.tex   : Another test file for charpath.tex (Plain TeX).
  113.     denis2.tex   : Another test file for charpath.tex (Plain TeX).
  114.     tp-test.tex  : Test file for textpath.tex (LaTeX).
  115.     tp-test.ps   : Output from tp-test.tex (PostScript).
  116.     multido.doc  : Documentation for multido.tex (LaTeX).
  117.     fancybox.doc : Documentation for fancybox.sty (LaTeX).
  118.     colortab.doc : Documentation for colortab.tex (LaTeX).
  119.  
  120.   Sources:
  121.     pstricks.doc : Source for pstricks.tex and pstricks.pro.
  122.     pst-node.doc : Source for pst-node.tex and pst-node.pro.
  123.     pst-coil.doc : Source for pst-coil.tex and pst-coil.pro.
  124.     pst-code.tex : LaTeX file for typesetting pstricks.doc.
  125.     pst-user.tex : LaTeX source for User's Guide.
  126.     pst-user.sty : Hacks for pst-user.tex.
  127.     defaults.pst : List of parameter defaults, for pst-user.tex.
  128.     pst-user.ind : Index for User's Guide.
  129.     tvz-hax.sty  : Hacks for pst-user.tex and pst-code.tex.
  130.     tvz-user.sty : Hacks for pst-user.tex.
  131.     tvz-code.sty : Hacks for pst-code.tex.
  132.     npsfont.sty  : Font macros for pst-user.tex.
  133.     pst-make.tex : For making .tex and .pro files
  134.  
  135. UPGRADING FROM EARLIER VERSIONS
  136.  
  137.   !!!! Typeset and read changes.tex carefully !!!!
  138.  
  139.   You need to reinstall the package in its entirety.
  140.  
  141.   There are a few incompatible changes from v0.92,
  142.   and many from earlier versions (see changes.tex).
  143.  
  144.   If using seminar.sty, you must upgrade to seminar.sty v0.93 or
  145.   the frame styles in semcolor.sty won't work.
  146.  
  147. PRINTING THE USER'S GUIDE:
  148.  
  149.   The User's Guide is distributed in PostScript format as
  150.   pst-usr1.ps, pst-usr2.ps and pst-usr3.ps.
  151.   There is also a quick reference, pst-quik.ps.
  152.  
  153.   Sun Newsprint/Pageview users: See relevant section below.
  154.  
  155.   The user's guide should print adequately on A4 paper, and it should
  156.   be possible to bind the users guide with or without 2-sided printing.
  157.   However, if you are a perfectionist, you can recompile pst-user.tex
  158.   with the a4 or twoside option, AFTER installing PSTricks. Good luck.
  159.  
  160.   The User's Guide uses less than 150K of virtual memory, which is well
  161.   below the minimal PostScript configuration. If you run out of memory,
  162.   try turning off the printer to flush out stuff left in memory
  163.   from previous jobs.
  164.  
  165.   Any other problems printing the .ps files should be reported to me.
  166.   However, you are on your own if you choose to typeset the LaTeX source
  167.   (pst-user.tex). LaTeXing pst-user.tex is NOT a good way to test PSTricks,
  168.   as there are too many other macros involved.
  169.  
  170. INSTALLATION FOR USERS OF ROKICKI'S DVIPS:
  171.  
  172.   1. Put the input files where your TeX looks for inputs.
  173.  
  174.   2. Put the PostScript .pro files where dvips looks for headers.
  175.      Probably /usr/lib/tex/ps on unix systems (if you cannot
  176.      write to this directory, put them in another directory and
  177.      include the path in the definition of \pstheader in pstricks.con).
  178.  
  179.   3. Typeset the LaTeX file samples.pst as a test and to see the samples.
  180.  
  181.   3. Have fun!
  182.  
  183. INSTALLATION FOR USERS OF ARBORTEXT'S DVIPS AND TEXTURES:
  184.  
  185.   1. Examine the configuration file pstricks.con.
  186.      Remove the configuration for Rokicki's dvips from the top of the file.
  187.      Replace it by the configuration for Arbortext's dvips or Textures,
  188.      which can be found towards the end of pstricks.con.
  189.  
  190.   2. If using Textures, decide whether you want to use a header file.
  191.  
  192.   3. Examine the end of pst-make.tex, and make changes if you do not want
  193.      to use a header file. Run pst-make.tex.
  194.  
  195.   4. Follow the instructions above for Rokicki's dvips, using
  196.      the pstricks.tex/.pro, pst-coil.tex/.pro and pst-node.tex/.pro
  197.      files that you generated rather than the ones that came with the package.
  198.  
  199. INSTALLATION FOR USERS OF OTHER DVI-TO-PS DRIVERS:
  200.  
  201.   PSTricks should be adaptable to other drivers with similar capabilities.
  202.   Feel free to contact me for help.
  203.  
  204.   1. Use pstricks.doc, pst-node.doc and pst-coil.doc as input files,
  205.      rather than the corresponding .tex files.
  206.  
  207.   2. Examine the configuration file pstricks.con.
  208.      Remove the configuration for Rokicki's dvips from the beginning
  209.      of the file.
  210.      Try to define the required commands appropriately for you driver,
  211.      perhaps using some of the configurations at the end for inspiration.
  212.      See the instructions in pstricks.con for details.
  213.  
  214.   3. Run pst-test.tex through Plain TeX until you get things to work
  215.      as well as possible. You may not be able to use all of PSTricks features,
  216.      but if you can define \pstverb and \pstunit, you at least can use
  217.      all the graphics objects.
  218.  
  219.   4. Decide whether your driver supports inclusion of a PostScript
  220.      header file. (PSTricks runs much more efficiently with a header,)
  221.  
  222.   5. See the end of pst-make.tex, and modify if not using a header file.
  223.      Run pst-make through Plain TeX or LaTeX.
  224.  
  225.   4. Follow the instructions above for Rokicki's dvips, using
  226.      the pstricks.tex/.pro, pst-coil.tex/.pro and pst-node.tex/.pro
  227.      files that you generated rather than the ones that came with the package.
  228.  
  229. CREATING A TEX FORMAT WITH PSTRICKS PRELOADED:
  230.  
  231.   See pstricks.con for instructions.
  232.  
  233. TIPS FOR HACKERS:
  234.  
  235.   The files pstricks.doc, pst-node.doc and pst-coil.doc contain
  236.   documentation and code, using Frank Mittelbach's doc system.
  237.   You can typeset pstricks.doc and pst-node.doc, if desired, by
  238.   running LaTeX on pst-code.tex. See pst-code.tex for details.
  239.   Don't expect too much from the documentation.
  240.  
  241.   If you want to modify the internals of PSTricks, use pstricks.doc,
  242.   pst-node.doc and pst-coil.doc as your input files, instead of the
  243.   corresponding .tex files. This allows you to modify
  244.   both the TeX and the PostScript macros.
  245.  
  246.   When you don't expect to make more changes for a while, run
  247.   pst-make.tex to generate new compact macro files and new
  248.   PostScript header file (if desired).
  249.  
  250.   Beware that the internal code in PSTricks is still unstable.
  251.  
  252. USING PSTRICKS WITH SUN'S PAGEVIEW/NEWSPRINT/OPENWINDOWS
  253.  
  254.   Sun's PageView/NeWSPrint/OpenWindows have many bugs.
  255.   Workarounds for several known problems of these have been coded into
  256.   PSTricks. A workaround for another bug is described below. Report other
  257.   problems to me.
  258.  
  259.   WARNING: The following has not been tested with PSTricks v0.93.
  260.  
  261.   A bug under Sun's PageView/NeWSprint 3.0 (perhaps fixed in 3.0.1),
  262.   causes vertical arrows to disturb the lines. To see if you have this problem,
  263.   try previewing the section in pst-usr*.ps on axes.
  264.  
  265.   As a workaround, add the following to the customization section of
  266.   pstricks.con, or replace the definitions of BeginArrow and EndArrow
  267.   in pstricks.doc with the following and rerun pst-make.tex.
  268.  
  269.     \pst@def{BeginArrow}<%
  270.       ADict begin
  271.         /@y1 ED /@x1 ED   % Tip
  272.         /@y2 ED /@x2 ED   % Tail
  273.         gsave
  274.           @x1 @y1 T
  275.           /@angle @x1 @x2 sub @y2 @y1 sub \tx@Atan def
  276.           @angle rotate
  277.           newpath>
  278.     \pst@def{EndArrow}<%
  279.           @x2 @y2
  280.           currentpoint
  281.           grestore
  282.         @angle matrix identmatrix rotate transform
  283.         @y1 add exch @x1 add exch
  284.       end>
  285.  
  286.   The arrow styles <<->>, >-<, >>-<<, and |*-|* will not work
  287.   right with this patch.
  288.  
  289. CONTRIBUTING TO PSTRICKS
  290.  
  291.   Please send me:
  292.  
  293.    * Whatever you can spare.
  294.    * Pretty/interesting/clever things you have created with PSTricks,
  295.      for possible inclusion in the User's Guide or samples.tex. Don't
  296.      be bashful!
  297.    * High level macros for trees/graphs, math diagrams, and linguistic
  298.      diagrams, based on PSTricks' node macros.
  299.    * Any other macros based on PSTricks.
  300.    * Contributions to the Tips and Tricks section of the User's Guide.
  301.    * Reports on +/- experiences with DVI-to-PS converters and previewers.
  302.    * Bug reports.
  303.    * pstricks.doc -- cleaned up, optimized, and documented.
  304.    * To Nepal.
  305.  
  306. PSTRICKS AND SEMINAR.STY
  307.  
  308.   The PSTricks package grew out of macros originally written for the
  309.   seminar.sty package.  seminar.sty is a LaTeX style for slides and notes.
  310.   seminar.sty, combined with pstricks.tex and your favorite macros for
  311.   inclusion of EPS files, make a complete TeX presentation software package.
  312.  
  313.   PSTricks v0.93 works with seminar.sty version 0.93, and maybe later
  314.   versions as well. The seminar.sty package is also available from
  315.   Princeton.EDU, and perhaps from wherever else you got PSTricks.
  316.  
  317.  
  318. ACKNOWLEDGEMENTS:
  319.  
  320.   The basic idea for the node macros is from Emma Pease's tree-dvips.sty.
  321.  
  322.   The algorithm in the \pscurve macro was adapted from a C program by
  323.   Shamim Zvonko Mohamed.
  324.  
  325.   Thanks to Geoffrey Tobin, David Jaffe, Thomas Worsch, Denis Girous,
  326.   and many other users for helpful comments.
  327.  
  328.   The author is thankful to Frank Mittelbach for his documentation system.
  329.  
  330.   Thanks to various contributors to samples.pst.
  331.  
  332.  
  333. DISCLAIMERS:
  334.  
  335.   This is just an elaborate hack. Not for use as children's sleepware.
  336.  
  337. %% END read-me.pst
  338.